Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: reprovider warning and announce-on|off profiles #10524

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

lidel
Copy link
Member

@lidel lidel commented Sep 24, 2024

TLDR

This PR aims to fix footgun that is lowpower profile + warn users who already sabotaged themselves by disabling reprovide system (not announcing to DHT).

Details

Users running on raspberrypi or other "lowpower" server often sabotaged themselves by disabling announcements when applying poorly documented lowpower profile (example).

To make matters worse, we've been prominently hinting that user should enable this profile to save resources, we did that in examples and docs (example – i've hidden this footgun from our docs, but the harm is already done)

This PR moves announcement settings to a separate profile, removing the footgun from lowpower one + warns users who have it disabled (if it was intentional, user can ignore the message).

TODO

  • announce-on/off profiles
  • lowprofile should not impact announcements
  • ipfs daemon should print warning when node is online but reprovide system is turned off
  • update docs/config
  • add changelog entry

@lidel lidel mentioned this pull request Sep 24, 2024
34 tasks
@lidel lidel force-pushed the feat/explitic-annouce-profiles branch 3 times, most recently from 0ea4eaa to e7fbb22 Compare September 27, 2024 23:33
@@ -299,7 +299,7 @@ Map of HTTP headers to set on responses from the RPC (`/api/v0`) HTTP server.
Example:
```json
{
"Foo": ["bar"]
"Foo": ["bar"]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ replaced tabs with space in entire file for consistency

@lidel lidel changed the title feat: explicit announce-on|off profiles feat: reprovider warning and announce-on|off profiles Sep 27, 2024
moving reprovide on/off to separate profile to avoid footgun
where node no longer announces to DHT + ipfs daemon check
that prints warning on start if reprovide system is disabled
@lidel lidel force-pushed the feat/explitic-annouce-profiles branch from e7fbb22 to 7dab0d1 Compare September 27, 2024 23:43
@lidel lidel marked this pull request as ready for review September 27, 2024 23:44
@lidel lidel requested a review from a team as a code owner September 27, 2024 23:44
@lidel lidel merged commit a8ecf01 into master Oct 3, 2024
14 checks passed
@lidel lidel deleted the feat/explitic-annouce-profiles branch October 3, 2024 19:39

> [!IMPORTANT]
> If you've ever applied the `lowpower` profile before, there is a high chance your node is not announcing to DHT anymore.
> If you have `Reprovider.Interval` set to `0` you may want to wet it to `22h` (or run `ipfs config profile apply announce-on`) to fix your system.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: wet -> set

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants